home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / s2a150.zip / S2A.DOC < prev    next >
Text File  |  1992-01-23  |  10KB  |  216 lines
  1.  
  2.  
  3.  
  4.  
  5.    ┌──────────────────────┬───────────────────────────────────────┬────────┐
  6.    │   Send·2·ALL v1.50   │  A Sysop and user bulletin generator  │ M ▀▀▄  │
  7.    │  Copyright (C) 1992  ├───────────────────────────────────────┤   ▄▄ █ │
  8.    │          by          │  Maelstrom Online Services 1:117/351  │  ████  │
  9.    │      Kit Cragin      │  Node 1 ■ (409)696-8722 USR HST Dual  │ █ ▀▀   │
  10.    │  Maelstrom Software  │  Node 2 ■ (409)764-6516 12/24MNP5     │  ▀▄▄ S │
  11.    └──────────────────────┴───────────────────────────────────────┴────────┘
  12.  
  13.  
  14.    DESCRIPTION                                       (Read HELLO.!!! first!)
  15.    ─────────────────────────────────────────────────────────────────────────
  16.    Send-2-All is an editor that allows SYSOPS AND USERS to create bulletins
  17.    which are added to an ANSI or ASCII file of bulletins. The bulletins
  18.    will be automatically removed when they expire. A daily maintenance
  19.    program will monitor the bulletins and update accordingly. It will run
  20.    on any system that supports the door drop files: DORINFO?.DEF and/or
  21.    DOOR.SYS. The editor generates ASCII & ANSI bulletins but runs in ANSI
  22.    mode only!
  23.  
  24.  
  25.    FEATURES
  26.    ─────────────────────────────────────────────────────────────────────────
  27.    A variety of Sysop configurable features has been created to make use of
  28.    this program easy and flexible.
  29.  
  30.    ■ All ANSI output is totally configurable.
  31.    ■ Generation of both ANSI or ASCII bulletins to any filename/directory.
  32.    ■ Allows the use of BBS control codes such as "allow abort" etc.
  33.    ■ Limit the number of total bulletins and number allowed per user.
  34.    ■ Choose the maximum number of days before a user's bulletin expires.
  35.    ■ Allows the sysop to force delete bulletins.
  36.    ■ Prevents 'TWIT' users from using the bulletin generator.
  37.    ■ Displays the most current bulletins first.
  38.    ■ Supports multi-node systems.
  39.    ■ Exits with errorlevel 200 when any change occurs in the bulletins.
  40.    ■ Text can be included from a file from within the editor.
  41.  
  42.    For those who register there will be these added features:
  43.  
  44.    ■ All `please register' notices/screens will be removed.
  45.    ■ The `preview bulletin' option in S2Asetup will be enabled.
  46.    ■ Stops 'BAD' words from being entered by the user via the BADWORDS.S2A
  47.    ■ Stops invalid BBS or ANSI control sequences from being entered.
  48.    ■ Sysops and users can revise one of their previous bulletins (S2A.EXE).
  49.    ■ Free REGISTERED updates as they become available.
  50.  
  51.  
  52.    LIABILITY
  53.    ─────────────────────────────────────────────────────────────────────────
  54.    The author of this software (Kit Cragin) assumes no liability whatsoever
  55.    for any damage or loss of data done to any person or computer system
  56.    which results from the use of Send·2·All software (S2A, S2AMAINT and
  57.    S2ASETUP).   [Not that anything is likely to happen!]
  58.  
  59.  
  60.    RESTRICTIONS/REGISTRATION
  61.    ─────────────────────────────────────────────────────────────────────────
  62.    Feel free to pass this software on to others (via upload or whatever),
  63.    but be sure there are no modifications of any kind, and that all the
  64.    files listed in the file HELLO.!!! are included.
  65.  
  66.    This software is NOT public domain. It is shareware. This means that you
  67.    can use it for a limited amount of time before you either decide to
  68.    register it, or discontinue use. In this case you can evaluate this pro-
  69.    duct for 30 days. At that time you should support the shareware concept
  70.    by filling out the form in REGISTER.S2A and sending in a paltry $15.
  71.  
  72.    Registration entitles you to ALL the benefits listed above.
  73.  
  74.    Registration also gives me an incentive to create new interesting and
  75.    useful programs for YOU! On behalf of all shareware authors, please sup-
  76.    port shareware!
  77.  
  78.    Lots of registrations will keep S2A going, and you may see these
  79.    additions:
  80.  
  81.    ■ Better ANSI/color support  ■ Suppression of certain fields
  82.    ■ Direct Telegard support    ■ Increased editor flexibility/Help Screen
  83.    ■ True multi-node support    ■ SysOps' suggestions
  84.  
  85.  
  86.    CONFIGURATION
  87.    ─────────────────────────────────────────────────────────────────────────
  88.    I have designed this program to be as simple and easy to set up as poss-
  89.    ible, because I know that many sysops hate to waste time writing batch
  90.    files and testing new programs. If you follow the steps below, the pro-
  91.    grams should run without a hitch.
  92.  
  93.    ┌─┐ Make sure that all of the files in this archive are in a directory
  94.    │1│ together, usually in some subdirectory off of your BBS or doors
  95.    └─┘ directory.
  96.  
  97.    ┌─┐ In that directory, run S2ASETUP.  If you are running a 1 node BBS
  98.    │2│ type S2ASETUP <enter>.  If you are running 2 or more lines, then
  99.    └─┘ type S2ASETUP CONFIG.n  (where n is the node number)  You will have
  100.        to do this for each line.  As a short cut, copy CONFIG.1 to
  101.        CONFIG.2 and change a few of the parameters as necessary.  Read
  102.        S2ASETUP.DOC for more info, then proceed to step 3.
  103.  
  104.    Step 3 applies to RA and QBBS sysops.  Consult your BBS documentation
  105.    for door installation if you run a different BBS type then do the
  106.    equivalent of Step 3 for your software.
  107.  
  108.    ┌─┐ Modify one of your .MNU files to include an option for Send-2-All.
  109.    │3│ ■ Create a type 7 or 15 exit and read BBS-SPEC.DOC.
  110.    └─┘ ■ For OPTIONAL DATA (type 7) or in your BATch file (type 15), type
  111.          in the full path and filename of the program, then put the path
  112.          and filename of the config file to use.  Both should have the
  113.          same path.  For example:
  114.  
  115.            ■ Single Node BBS:
  116.                C:\BBS\DOORS\S2A\S2A.EXE C:\DOORS\S2A\CONFIG.S2A
  117.  
  118.            ■ Multinode BBS:
  119.                C:\BBS\DOORS\S2A\S2A.EXE C:\DOORS\S2A\CONFIG.*P
  120.  
  121.            ■ Mulitnode & calling a batch file:
  122.                *C /C C:\BBS\BAT\S2A.BAT *P
  123.              where the contents of S2A.BAT can be something like:
  124.                C:\BBS\DOORS\S2A\S2A C:\DOORS\S2A\CONFIG.%1
  125.                if ERRORLEVEL 200 echo User Saved a bulletin!
  126.  
  127.    ┌─┐ In your BBS batch file, or wherever you do daily maintenance, add
  128.    │4│ a line to run the maintenance program, S2AMAINT.EXE.
  129.    └─┘ For example:
  130.  
  131.               C:\BBS\DOORS\S2A\S2AMAINT C:\DOORS\S2A\CONFIG.S2A
  132.  
  133.    ┌─┐ Create the file TWITUSER.S2A (if needed) and put one name per line
  134.    │5│ of those people that you do not want to use the program.  This is a
  135.    └─┘ plain text file and is optional.
  136.  
  137.    Step 6 applies to registered owners of Send·2·ALL only.
  138.  
  139.    ┌─┐ Edit the BADWORDS.S2A file as needed.  This is a file of words or
  140.    │6│ characters/control sequences that you don't want to appear in the
  141.    └─┘ users' bulletins. You may want to include all the cuss words you
  142.        can think of and the ASCII #6, #11, and ESCape characters. Just
  143.        make sure that each word or sequence is entered on a line by
  144.        itself, up to 15 characters each, 50 words total. The program
  145.        scans for any occurrence of the pattern in the line, so if you
  146.        have 'BUTT' in BADWORDS.S2A the word 'Butter' will be flagged as
  147.        BAD in the text.  To prevent this put  ' BUTT ' in BADWORDS.S2A
  148.        instead; note the spaces before & after─^────^.
  149.        ** This file is OPTIONAL! **
  150.  
  151.  
  152.    RUNNING THE PROGRAM
  153.    ─────────────────────────────────────────────────────────────────────────
  154.    ■ To run the editor (S2A) program locally, type:
  155.  
  156.         S2A <config filename> /L <first name> <Last name>
  157.  
  158.      <config filename> is the config you want to use. Use /F as a shortcut
  159.                        for CONFIG.S2A
  160.      /L                means local mode
  161.      <first> <last>    are optional and are the `alias' name to post under.
  162.  
  163.    ■ If you are a registered user, you will have the option to revise an
  164.      old bulletin [P] or add a new bulletin [N].
  165.  
  166.    ■ Edit the header first then the text.  Note that in the text you can
  167.      use most of the `standard' editor keys.  Ctrl-Z will save, Ctrl-A will
  168.      abort.  Ctrl-Y Deletes a line, Ctrl-I Inserts a line.
  169.  
  170.    ■ To start the bulletin generator 'from scratch', delete BULLETIN.S2A
  171.  
  172.    ■ While a user is on-line, the sysop can hit:
  173.          ■ Alt-D to reduce the user's time.
  174.          ■ Alt-H to force an immediate exit.
  175.          ■ Alt-I to include text from a file.
  176.          ■ Alt-L to add user to TWIT file and force an immediate exit.
  177.  
  178.  
  179.    INSERTING TEXT FROM A FILE
  180.    ─────────────────────────────────────────────────────────────────────────
  181.    Hitting Alt-I will allow you to import text from a file.  Any text can
  182.    be imported with 2 restrictions:
  183.  
  184.    1.  The text will be forced to fit within the bulletin's text area. (If
  185.        you are importing a file that is 50 chars across by 10 lines and you
  186.        have defined a 20x15 area, you will get only 20 columns of text from
  187.        the file but all the lines of text.)
  188.  
  189.    2.  Text from the file CAN contain ansi, but color sequences ONLY.  No
  190.        cursor movements, clearscreen, etc are allowed (since the ASCII output
  191.        file would look real messy.  The color sequences ARE stripped out of
  192.        it though.) The length of each line INCLUDING ansi sequences needs to
  193.        fit within the text area.
  194.  
  195.  
  196.    MULTI-NODE OPERATION
  197.    ─────────────────────────────────────────────────────────────────────────
  198.    If your system has multiple nodes, S2A will automatically check for
  199.    the existence of the file INUSE.S2A, which is a temporary file saying
  200.    that the program is in use. If it exists, a message will be displayed
  201.    that tells that user to try again later. INUSE.S2A is removed at program
  202.    termination.  No setup is necessary.
  203.  
  204.    SUPPORT
  205.    ─────────────────────────────────────────────────────────────────────────
  206.    I hope you find Send-2-ALL useful and enjoyable. If you have any com-
  207.    ments, suggestions, problems, or questions contact me by:
  208.  
  209.    ■ FIDO NETmail at 1:117/351
  210.    ■ Calling Maelstrom at 409-696-8722 or 409-764-6516
  211.    ■ Leaving a message in FIDO's DOORWARE or RA_UTIL echos
  212.    ■ using USmail at PO Box 9078, College Station, TX 77842
  213.  
  214.                 ── Kit
  215.  
  216.